<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	<head>
		<meta http-equiv="content-type" content="text/html; charset=utf-8" />
		<meta name="generator" content="JsDoc Toolkit" />
		
		<title>JsDoc Reference - Cal3D.CalCoreSkeleton</title>

		<style type="text/css">
			/* default.css */


body
{
	font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
	width: 800px;
}

.header
{
	clear: both;
	background-color: #ccc;
	padding: 8px;
}

h1
{
	font-size: 150%;
	font-weight: bold;
	padding: 0;
	margin: 1em 0 0 .3em;
}

hr
{
	border: none 0;
	border-top: 1px solid #7F8FB1;
	height: 1px;
}

pre.code
{
	display: inline;
//	padding: 8px;
//	border: 1px dashed #ccc;
	background-color: #4AA02C;
}

#index
{
	margin-top: 24px;
	float: left;
	width: 160px;
	position: absolute;
	left: 8px;
	background-color: #F3F3F3;
	padding: 8px;
}

#content
{
	margin-left: 190px;
	width: 600px;
}

.classList
{
	list-style-type: none;
	padding: 0;
	margin: 0 0 0 8px;
	font-family: arial, sans-serif;
	font-size: 1em;
	overflow: auto;
}

.classList li
{
	padding: 0;
	margin: 0 0 8px 0;
}

.summaryTable { width: 100%; }

h1.classTitle
{
	font-size:170%;
	line-height:130%;
}

h2 { font-size: 110%; }
caption, div.sectionTitle
{
	background-color: #7F8FB1;
	color: #fff;
	font-size:130%;
	text-align: left;
	padding: 2px 6px 2px 6px;
	border: 1px #7F8FB1 solid;
}

div.sectionTitle { margin-bottom: 8px; }
.summaryTable thead { display: none; }

.summaryTable td
{
	vertical-align: top;
	padding: 4px;
	border-bottom: 1px #7F8FB1 solid;
	border-right: 1px #7F8FB1 solid;
}

/*col#summaryAttributes {}*/
.summaryTable td.attributes
{
	border-left: 1px #7F8FB1 solid;
	width: 140px;
	text-align: right;
}

td.attributes, .fixedFont
{
	line-height: 15px;
	color: #002EBE;
	font-family: "Courier New",Courier,monospace;
	font-size: 13px;
}

.summaryTable td.nameDescription
{
	text-align: left;
	font-size: 13px;
	line-height: 15px;
}

.summaryTable td.nameDescription, .description
{
	line-height: 15px;
	padding: 4px;
	padding-left: 4px;
}

.summaryTable { margin-bottom: 8px; }

ul.inheritsList
{
	list-style: square;
	margin-left: 20px;
	padding-left: 0;
}

.detailList {
	margin-left: 20px; 
	line-height: 15px;
}
.detailList dt { margin-left: 20px; }

.detailList .heading
{
	font-weight: bold;
	padding-bottom: 6px;
	margin-left: 0;
}

.light, td.attributes, .light a:link, .light a:visited
{
	color: #777;
	font-style: italic;
}

.fineprint
{
	text-align: right;
	font-size: 10px;
}
		</style>
	</head>

	<body>
<!-- ============================== header ================================= -->	
		<!-- begin static/header.html -->
		<div id="header">
</div>
		<!-- end static/header.html -->

<!-- ============================== classes index ============================ -->
		<div id="index">
			<!-- begin publish.classesIndex -->
			<div align="center"><a href="../index.html">Class Index</a>
| <a href="../files.html">File Index</a></div>
<hr />
<h2>Classes</h2>
<ul class="classList">
	
	<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
	
	<li><a href="../symbols/Cal3D.html">Cal3D</a></li>
	
	<li><a href="../symbols/Cal3D.CalAbstractMixer.html">Cal3D.CalAbstractMixer</a></li>
	
	<li><a href="../symbols/Cal3D.CalAnimation.html">Cal3D.CalAnimation</a></li>
	
	<li><a href="../symbols/Cal3D.CalAnimationAction.html">Cal3D.CalAnimationAction</a></li>
	
	<li><a href="../symbols/Cal3D.CalAnimationCallback.html">Cal3D.CalAnimationCallback</a></li>
	
	<li><a href="../symbols/Cal3D.CalAnimationCycle.html">Cal3D.CalAnimationCycle</a></li>
	
	<li><a href="../symbols/Cal3D.CalBone.html">Cal3D.CalBone</a></li>
	
	<li><a href="../symbols/Cal3D.CalBoundingBox.html">Cal3D.CalBoundingBox</a></li>
	
	<li><a href="../symbols/Cal3D.CalBufferSource.html">Cal3D.CalBufferSource</a></li>
	
	<li><a href="../symbols/Cal3D.CalCoreAnimation.html">Cal3D.CalCoreAnimation</a></li>
	
	<li><a href="../symbols/Cal3D.CalCoreBone.html">Cal3D.CalCoreBone</a></li>
	
	<li><a href="../symbols/Cal3D.CalCoreKeyframe.html">Cal3D.CalCoreKeyframe</a></li>
	
	<li><a href="../symbols/Cal3D.CalCoreMaterial.html">Cal3D.CalCoreMaterial</a></li>
	
	<li><a href="../symbols/Cal3D.CalCoreMaterial.Color.html">Cal3D.CalCoreMaterial.Color</a></li>
	
	<li><a href="../symbols/Cal3D.CalCoreMaterial.Map.html">Cal3D.CalCoreMaterial.Map</a></li>
	
	<li><a href="../symbols/Cal3D.CalCoreMesh.html">Cal3D.CalCoreMesh</a></li>
	
	<li><a href="../symbols/Cal3D.CalCoreModel.html">Cal3D.CalCoreModel</a></li>
	
	<li><a href="../symbols/Cal3D.CalCoreMorphAnimation.html">Cal3D.CalCoreMorphAnimation</a></li>
	
	<li><a href="../symbols/Cal3D.CalCoreSkeleton.html">Cal3D.CalCoreSkeleton</a></li>
	
	<li><a href="../symbols/Cal3D.CalCoreSubmesh.html">Cal3D.CalCoreSubmesh</a></li>
	
	<li><a href="../symbols/Cal3D.CalCoreSubmesh.Face.html">Cal3D.CalCoreSubmesh.Face</a></li>
	
	<li><a href="../symbols/Cal3D.CalCoreSubmesh.Influence.html">Cal3D.CalCoreSubmesh.Influence</a></li>
	
	<li><a href="../symbols/Cal3D.CalCoreSubmesh.PhysicalProperty.html">Cal3D.CalCoreSubmesh.PhysicalProperty</a></li>
	
	<li><a href="../symbols/Cal3D.CalCoreSubmesh.Spring.html">Cal3D.CalCoreSubmesh.Spring</a></li>
	
	<li><a href="../symbols/Cal3D.CalCoreSubmesh.TangentSpace.html">Cal3D.CalCoreSubmesh.TangentSpace</a></li>
	
	<li><a href="../symbols/Cal3D.CalCoreSubmesh.TextureCoordinate.html">Cal3D.CalCoreSubmesh.TextureCoordinate</a></li>
	
	<li><a href="../symbols/Cal3D.CalCoreSubmesh.Vertex.html">Cal3D.CalCoreSubmesh.Vertex</a></li>
	
	<li><a href="../symbols/Cal3D.CalCoreSubMorphTarget.html">Cal3D.CalCoreSubMorphTarget</a></li>
	
	<li><a href="../symbols/Cal3D.CalCoreSubMorphTarget.BlendVertex.html">Cal3D.CalCoreSubMorphTarget.BlendVertex</a></li>
	
	<li><a href="../symbols/Cal3D.CalCoreTrack.html">Cal3D.CalCoreTrack</a></li>
	
	<li><a href="../symbols/Cal3D.CalError.html">Cal3D.CalError</a></li>
	
	<li><a href="../symbols/Cal3D.CalLibraryConstants.html">Cal3D.CalLibraryConstants</a></li>
	
	<li><a href="../symbols/Cal3D.CalLoader.html">Cal3D.CalLoader</a></li>
	
	<li><a href="../symbols/Cal3D.CalLoadingCallback.html">Cal3D.CalLoadingCallback</a></li>
	
	<li><a href="../symbols/Cal3D.CalMatrix.html">Cal3D.CalMatrix</a></li>
	
	<li><a href="../symbols/Cal3D.CalMesh.html">Cal3D.CalMesh</a></li>
	
	<li><a href="../symbols/Cal3D.CalMixer.html">Cal3D.CalMixer</a></li>
	
	<li><a href="../symbols/Cal3D.CalModel.html">Cal3D.CalModel</a></li>
	
	<li><a href="../symbols/Cal3D.CalMorphTargetMixer.html">Cal3D.CalMorphTargetMixer</a></li>
	
	<li><a href="../symbols/Cal3D.CalPhysique.html">Cal3D.CalPhysique</a></li>
	
	<li><a href="../symbols/Cal3D.CalQuaternion.html">Cal3D.CalQuaternion</a></li>
	
	<li><a href="../symbols/Cal3D.CalRenderer.html">Cal3D.CalRenderer</a></li>
	
	<li><a href="../symbols/Cal3D.CalSkeleton.html">Cal3D.CalSkeleton</a></li>
	
	<li><a href="../symbols/Cal3D.CalSubmesh.html">Cal3D.CalSubmesh</a></li>
	
	<li><a href="../symbols/Cal3D.CalSubmesh.Face.html">Cal3D.CalSubmesh.Face</a></li>
	
	<li><a href="../symbols/Cal3D.CalSubmesh.PhysicalProperty.html">Cal3D.CalSubmesh.PhysicalProperty</a></li>
	
	<li><a href="../symbols/Cal3D.CalSubmesh.TangentSpace.html">Cal3D.CalSubmesh.TangentSpace</a></li>
	
	<li><a href="../symbols/Cal3D.CalVector.html">Cal3D.CalVector</a></li>
	
</ul>
<hr />
			<!-- end publish.classesIndex -->
		</div>
		
		<div id="content">
<!-- ============================== class title ============================ -->
			<h1 class="classTitle">
				
				Class Cal3D.CalCoreSkeleton
			</h1>

<!-- ============================== class summary ========================== -->			
			<p class="description">
				
			
				CalCoreSkeleton
				
				
					<br /><i>Defined in: </i> <a href="../symbols/src/cal3djs_coreskeleton.js.html">coreskeleton.js</a>.
				
			</p>

<!-- ============================== constructor summary ==================== -->			
			
			<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class Cal3D.CalCoreSkeleton.">
				<caption>Class Summary</caption>
				<thead>
					<tr>
						<th scope="col">Constructor Attributes</th>
						<th scope="col">Constructor Name and Description</th>
					</tr>
				</thead>
				<tbody>
					<tr>
						<td class="attributes">&nbsp;</td>
						<td class="nameDescription" >
							<div class="fixedFont">
								<b><a href="../symbols/Cal3D.CalCoreSkeleton.html">Cal3D.CalCoreSkeleton</a></b>()
							</div>
							<div class="description"></div>
						</td>
					</tr>
				</tbody>
			</table>
			

<!-- ============================== properties summary ===================== -->
			

<!-- ============================== methods summary ======================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class Cal3D.CalCoreSkeleton.">
					<caption>Method Summary</caption>
					<thead>
						<tr>
							<th scope="col">Method Attributes</th>
							<th scope="col">Method Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/Cal3D.CalCoreSkeleton.html#addCoreBone">addCoreBone</a></b>(coreBone)
								</div>
								<div class="description">Add a core bone.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/Cal3D.CalCoreSkeleton.html#calculateBoundingBoxes">calculateBoundingBoxes</a></b>(coreModel)
								</div>
								<div class="description">Calculate bounding boxes of core bones.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/Cal3D.CalCoreSkeleton.html#calculateState">calculateState</a></b>()
								</div>
								<div class="description">Calculate the current state.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/Cal3D.CalCoreSkeleton.html#getCoreBone">getCoreBone</a></b>(coreBoneId)
								</div>
								<div class="description">Get a core bone.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/Cal3D.CalCoreSkeleton.html#getCoreBoneId">getCoreBoneId</a></b>(name)
								</div>
								<div class="description">Get the ID of a specified core bone.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/Cal3D.CalCoreSkeleton.html#getVectorCoreBone">getVectorCoreBone</a></b>()
								</div>
								<div class="description">Get the core bone list.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/Cal3D.CalCoreSkeleton.html#getVectorRootCoreBoneId">getVectorRootCoreBoneId</a></b>()
								</div>
								<div class="description">Get the root core bone ID list.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/Cal3D.CalCoreSkeleton.html#mapCoreBoneName">mapCoreBoneName</a></b>(coreBoneId, name)
								</div>
								<div class="description">Map the name to a specific ID of a core bone.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/Cal3D.CalCoreSkeleton.html#scale">scale</a></b>(The)
								</div>
								<div class="description">Scale the core skeleton.</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
			
<!-- ============================== events summary ======================== -->
			

<!-- ============================== constructor details ==================== -->		
			
			<div class="details"><a name="constructor"> </a>
				<div class="sectionTitle">
					Class Detail
				</div>
				
				<div class="fixedFont">
						<b>Cal3D.CalCoreSkeleton</b>()
				</div>
				
				<div class="description">
					
					
				</div>
				
				
				
				
					
					
					
					
					
					
					

			</div>
			

<!-- ============================== field details ========================== -->		
			

<!-- ============================== method details ========================= -->		
			
				<div class="sectionTitle">
					Method Detail
				</div>
				
					<a name="addCoreBone"> </a>
					<div class="fixedFont">
					
					<span class="light">{number}</span>
					<b>addCoreBone</b>(coreBone)
					
					</div>
					<div class="description">
						Add a core bone.<br />
	This function adds a core bone to the core skeleton instance.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{<a href="../symbols/Cal3D.CalCoreBone.html">Cal3D.CalCoreBone</a>}</span> <b>coreBone</b>
									
								</dt>
								<dd>The core bone to be added.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{number}</span> ID of the added core bone.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="calculateBoundingBoxes"> </a>
					<div class="fixedFont">
					
					
					<b>calculateBoundingBoxes</b>(coreModel)
					
					</div>
					<div class="description">
						Calculate bounding boxes of core bones.<br />
	This function calculates the bounding box of every bone in the core skeleton.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{<a href="../symbols/Cal3D.CalCoreModel.html">Cal3D.CalCoreModel</a>}</span> <b>coreModel</b>
									
								</dt>
								<dd>The coreModel needed to retrieve vertices.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="calculateState"> </a>
					<div class="fixedFont">
					
					
					<b>calculateState</b>()
					
					</div>
					<div class="description">
						Calculate the current state.<br />
	This function calculates the current state of the core skeleton instance by calculating all the core bone states.
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="getCoreBone"> </a>
					<div class="fixedFont">
					
					<span class="light">{<a href="../symbols/Cal3D.CalCoreBone.html">Cal3D.CalCoreBone</a>}</span>
					<b>getCoreBone</b>(coreBoneId)
					
					</div>
					<div class="description">
						Get a core bone.<br />
	This function returns the core bone with the given name or ID.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{string | number}</span> <b>coreBoneId</b>
									
								</dt>
								<dd>The name or ID of the core bone.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{<a href="../symbols/Cal3D.CalCoreBone.html">Cal3D.CalCoreBone</a>}</span> The core bone.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="getCoreBoneId"> </a>
					<div class="fixedFont">
					
					<span class="light">{number}</span>
					<b>getCoreBoneId</b>(name)
					
					</div>
					<div class="description">
						Get the ID of a specified core bone.<br />
	This function returns the ID of a specified core bone.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{string}</span> <b>name</b>
									
								</dt>
								<dd>The name of the core bone whose ID should be returned.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{number}</span> The ID associated with the given name.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="getVectorCoreBone"> </a>
					<div class="fixedFont">
					
					<span class="light">{Array}</span>
					<b>getVectorCoreBone</b>()
					
					</div>
					<div class="description">
						Get the core bone list.<br />
	This function returns the vector that contains all core bones of the core skeleton instance.
						
						
					</div>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Array}</span> The core bone list.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="getVectorRootCoreBoneId"> </a>
					<div class="fixedFont">
					
					<span class="light">{Array}</span>
					<b>getVectorRootCoreBoneId</b>()
					
					</div>
					<div class="description">
						Get the root core bone ID list.<br />
	This function returns the list that contains all root core bone IDs of the core skeleton instance.
						
						
					</div>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Array}</span> The root core bone ID list.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="mapCoreBoneName"> </a>
					<div class="fixedFont">
					
					<span class="light">{boolean}</span>
					<b>mapCoreBoneName</b>(coreBoneId, name)
					
					</div>
					<div class="description">
						Map the name to a specific ID of a core bone.<br />
	This function returns true or false depending on whether the mapping was successful or not. Note that it is possible to overwrite 
	and existing mapping and no error will be given.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{number}</span> <b>coreBoneId</b>
									
								</dt>
								<dd>ID of the core bone to be associated with the name.</dd>
							
								<dt>
									<span class="light fixedFont">{string}</span> <b>name</b>
									
								</dt>
								<dd>The name of the core bone that will be associated with the ID.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{boolean}</span> true if succeeded; false if failed.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="scale"> </a>
					<div class="fixedFont">
					
					
					<b>scale</b>(The)
					
					</div>
					<div class="description">
						Scale the core skeleton.<br />
	This function rescale all the data that are in the core skeleton instance.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{number}</span> <b>The</b>
									
								</dt>
								<dd>scale factor.</dd>
							
							</dl>
						
						
						
						
						
						
						

					
				
			
			
<!-- ============================== event details ========================= -->		
			
			
			<hr />
		</div>

		
<!-- ============================== footer ================================= -->
		<div class="fineprint" style="clear:both">
			
			Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Wed Sep 14 2011 17:55:16 GMT+0800 (CST)
		</div>
	</body>
</html>
